home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / idxutil3.zip / IDX-UTIL.DOC < prev   
Text File  |  1992-12-01  |  19KB  |  385 lines
  1. PCB-UTIL.DOC - Release 3 - December 01, 1992 - Gary Meeker
  2.  
  3. This document contains information on how to use:
  4.    IDX-DUPS Version 2.10,
  5.    IDX-LIST Version 1.10,
  6.    IDX-SORT Version 1.00,
  7.    IDX-MERG Version 1.00,
  8.    IDX-DRIV Version 2.00,
  9.    IDX-RSET Version 1.00 and
  10.    IDX-EDIT Version 1.00.
  11.  
  12.    These programs are released as FREEWARE to all REGISTERED PCBoard
  13. Version 14.5(a) Sysops.  The Copyright is retained by Gary Meeker.
  14.  
  15.    What does this mean?  If you have purchased a licence for PCBoard
  16. V14.5(a) from Clark Development, then you are entitled to copy and use
  17. these utilities on as many computers as allowed by your licence from
  18. Clark Development.  If you have an illegal copy of PCBoard V14.5(a),
  19. these programs are not for YOU.
  20.  
  21. =========================================================================
  22. *DISCLAIMER*DISCLAIMER*DISCLAIMER*DISCLAIMER*DISCLAIMER*DISCLAIMER*
  23.  
  24. Every effort has been made to avoid error and moderately extensive testing
  25. has been performed on these programs, however, I do not warrant them to be
  26. fit for any purpose or to be free from error and disclaims any liability
  27. for actual or any other damage arising from the use of these programs.
  28.  
  29. ENSURE YOU KEEP UP-TO-DATE BACKUPS OF ALL YOUR IMPORTANT FILES.
  30.  
  31. *DISCLAIMER*DISCLAIMER*DISCLAIMER*DISCLAIMER*DISCLAIMER*DISCLAIMER*
  32. =========================================================================
  33. IDX-DUPS Version 2.10   (12/01/92)
  34.    List duplicate entries in a PCBoard 14.5(a) File Index.  To use type:
  35.  
  36.       IDX-DUPS indexname[.IDX]  [indexname2.IDX]]  [/Q]  [/I]  [/Kn]
  37.  
  38. Where indexfile[.IDX] is the name of the index file to display.
  39. (The .IDX file extension is optional.  Do not include the '[' or ']'.)
  40.  
  41. Optionally you may include an indexname2[.IDX] which will be compared against
  42.  the first. Duplicates in the first will still be reported, but any files
  43.  found in the second which are also in the first will also be reported.
  44.  Duplicates in the second index will only be reported if they are also
  45.  in the first.
  46.  
  47.  [/Q] supresses the header info from the output.
  48.  
  49.  [/I] creates a file called COMMON.IDX containing the Index information
  50.   from the second Index when a file matches from the first index.
  51.   You can include a 3rd IndexfileName to override the default name.
  52.   Make sure you don't use the name of a file already on the disk or it
  53.   will be overwritten (unless that is what you want.) New with 2.00 is
  54.   the ability to use /I with a single IndexFile and get a COMMON.IDX
  55.   listing the Duplicates.
  56.  
  57.  [/Kn] Kill Duplicates. n:1=Prompt on all files (default)
  58.                           2=Prompt on different size files
  59.                           3=Don't prompt at all (Use with caution)
  60.  
  61.   This feature only works when two .IDX files are specified. The files from
  62.   the second .IDX files are the ones that will be deleted. If you have a
  63.   CD-ROM, you would want to specify it first and your Hard Disk(s) .IDX file
  64.   second, followed by /K (and 1, 2 or 3... If only /K is specified 1 is
  65.   assumed).
  66.  
  67.  
  68. I setup a CD-Rom conference available to only those Users who contributed
  69. to making the purchase of the CD-Rom Drives & Disks possible. All the
  70. CD-Rom files are available from that conference but not the Main Board
  71. or other Conference Files (accept the Masterfile list Directory.)
  72. I used this to find all the files on my Hard Disks that were also on the
  73. new CD-Roms. I feed DLPATH.LST to MAKEIDX to create an Index for my Hard
  74. Drives. Then using this utility I created an Index of the Duplicates.  I
  75. added both of these (one for each CD-Rom) to the DLPATH.LST and deleted
  76. the files from the Hard Drives. This way I didn't loose any files from my
  77. board available to everyone but was able to free up the storage space they
  78. were taking up. My Users could not tell the difference and everyone was
  79. happy. Once IDX-Edit is finished I can add some of the files on the CD-Rom
  80. to these Indexes to help fill out some of the Conferences which are bare
  81. of files right now. I could copy the files from the CD-Rom to the Hard Drives
  82. and create another Index of the Dups to add them in, but it will be easier
  83. after the routine gets finished.
  84.  
  85.  
  86. V2.1 Fixed problem with display of <A: value on first .IDX file.
  87. =========================================================================
  88. IDX-List Version 1.10   (12/01/92)
  89.    List entries in a PCBoard 14.5(a) File Index.  To use type:
  90.  
  91.       IDX-LIST indexname[.IDX]  [filemask]  [/Q]
  92.  
  93. Where indexname[.IDX] is the name of the index file to list.
  94. (The .IDX file extension is optional.)
  95.  
  96.  and [filemask] is the file or wildcard match to list."
  97.  
  98. [/Q] supresses the header info from the output.
  99.  
  100. Version 1.10 fixes a problem with the filemask when it did not include a
  101. '.' in it. and a problem with display of <A: value on.
  102. =========================================================================
  103. IDX-Sort Version 1.00   (12/01/92)
  104.    Sort entries in a PCBoard 14.5(a) File Index.  To use type:
  105.  
  106.       IDX-SORT indexname[.IDX]  [/Q]
  107.  
  108. Where indexname[.IDX] is the name of the index file to sort.
  109. (The .IDX file extension is optional.)
  110.  
  111. [/Q] supresses the header info from the output.
  112.  
  113. Provided there is enough memory to do the sort, this program will read the
  114. index file into memory and sort the index.
  115. =========================================================================
  116. IDX-MERG Version 1.00   (12/01/92)
  117.    Combine two PCBoard 14.5(a) File Indexes into one
  118.  
  119.       IDX-MERG indexname1[.IDX]  indexname2[.IDX]  [indexname3[.IDX]]  [/Q]
  120.  
  121. Where indexname1[.IDX] and indexname2[.IDX] are the names of the index
  122.  files to merge.
  123.  
  124. Where [indexname3[.IDX]] is the name of the index file to be created.
  125.  this is optional, if omitted COMMON.IDX will be used"
  126.  
  127. Note: The .IDX extension is optional. Do not include the '[' or ']'.
  128.  
  129. [/Q] supresses the header info from the output.
  130.  
  131. NOTE: DO NOT name the output file as either of the two input files or you
  132.       will destroy it!
  133.  
  134. IDX-MERG is designed to create a single IDX file from two IDX files. This
  135. allows creating 1 large IDX file to scan for duplicates or just to use
  136. with PCBoard rather than including several entries in your DLPATH.LST file.
  137. I created it to combine the NightOwl series IDX files into a single file
  138. to compare against other CD-ROMs and against my Hard Disk (using IDX-DUPS).
  139. You could just create a .PTH file containing multiple drive\paths and let
  140. MAKEIDX create the large IDX file if you have enough CD-ROM drives to hold
  141. all the CD-ROMS you are trying to index, but I only had a single drive at
  142. the time and wanted to combine several CD-ROMs into 1 file. IDX-DRIV (below)
  143. has also been changed to allow changing the paths on a single CD-ROM when
  144. they are combined in a single IDX file. Use IDX-EDIT to list the Range
  145. of path entries for each CD-ROM after combining (or do the math by hand).
  146. =========================================================================
  147. IDX-DRIV Version 2.00   (12/01/92)
  148.    Set Drive Letter on all paths in a PCBoard 14.5(a) File Index. To use type
  149.  
  150.       IDX-DRIV indexname[.IDX]  DriveLetter  [/Q] [/R:Start-End]
  151.  
  152. Where indexname[.IDX] is the name of the index file to set.
  153.  
  154. DriveLetter is the Drive Letter to assign to all paths
  155.  
  156. [/Q]            supresses the header info from the output.
  157. [/R:Start-End]  specifies the Starting and Ending Path numbers to change.
  158.                   Must include '-' and no spaces. Example /R:1-35
  159.  
  160. IDX-DRIV is designed to modify the Paths in an IDX file to whatever drive
  161. letter you desire (This is quicker than using MAKEIDX again just because
  162. you changed the drive letter).
  163.  
  164. Version 2.00 includes the abilty to specify the Starting and Ending Path
  165. numbers to change, allowing the changing of Drive letters when using a
  166. combined IDX file. (Created with MAKEIDX using a .PTH file containing
  167. multiple CD-ROM drive/paths or using IDX-MERG to combine multiple .IDX files.)
  168. =========================================================================
  169. IDX-RSET Version 1.00   (06/01/92)
  170.    Set Active CD-Roms and Drives in a PCBoard 14.5(a) File Indexes. To use type
  171.  
  172.       IDX-RSET ConfigFile  [/Q]"
  173.  
  174. Where: ConfigFile = Drive:Path to our configuration file.
  175.  
  176. [/Q] supresses the header info from the output.
  177.  
  178.  
  179. The ConfigFile contains 4 or more lines:
  180. Line 1: Loc/Name of the CDROM database File
  181. Line 2: Place CD-ROM Index Files at Beginning of DLPATH.LST files.
  182. Line 3: Number of DLPATH.LST files to check
  183. Line 4+ Loc/Name of each DLPATH.LST file to be checked/altered
  184.  
  185. The CDROM database File contains 3 or more lines
  186. Line 1: Number of CD-ROMS listed in database, List of Drives for CD-ROMS
  187. Line 2+ CDRom Name Label, Loc/Name of IndexFile, TestFile
  188.  
  189.  
  190. IDX-RSET is designed to assist in changing CD-ROMS if you have more CD-ROMS
  191. than drives. First create an Index file for each CD-ROM using MAKEIDX. Next
  192. create the CDROM DataBase file using a text editor. Line 1 defines how many
  193. CD-ROMS will be listed in the data base and a list of CD-ROM Drive letters
  194. with no spaces or seperators (ie. STU or STUVWX). The following lines include
  195. a label for identifying the CD-ROM (used only as output name for your use)
  196. (but NOTE: DO NOT include a comma in the label)), the Drive:\Path\Filename
  197. of the indexfile for this CD-ROM, and a test file unique to this CD-ROM to
  198. allow the program to identify the CD-ROM (DO NOT include a drive letter or
  199. leading :\ for the path.)
  200.  
  201. Example (I have 2 CD-ROMS and 1 Drive)
  202.  
  203. 2,S
  204. CD-Rom1, H:\IDX-ROM1.IDX, ROM01\1603.ZIP
  205. CD-Rom2, H:\IDX-ROM2.IDX, ROM201\ALTBRN12.ZIP
  206.  
  207. Next create the config file using a text editor. The first line contains
  208. the Drive:\Path\Filename of the above database. The second line determines
  209. if the CD-ROM Index files should be listed at the beginning (YES) or the
  210. end (NO) of the DLPATH.LST files (NOTE: a special mode is available by the
  211. use of AUTO which causes the Index files to be listed after the end of the
  212. first occurances of INDEX files in the DLPATH.LST file). The third Line
  213. contains the number of DLPATH.LST files to be checked. The following lines
  214. contain the Drive:\PATH\Filenames of each of the DLPATH.LST files.
  215.  
  216. When run, IDX-RSET will Check each CD-ROM listed and determine which drive
  217. it is in. It will then modify the INDEX file so the PATHS will contain the
  218. proper Drive letter. Once each CD-ROM is located it will read each of the
  219. DLPATH.LST files listed and look for INDEX files. If the Index File is one
  220. of the files listed, it will be skipped. Any other INDEX file as well as any
  221. other line will be copied to the new DLPATH.LST file which will then be
  222. renamed to the origional file. The result will be a DLPATH.LST file which will
  223. contain the proper index files for the CD-ROMS that are found to be online
  224. and the index files modified so the paths contain the proper Drive letter.
  225. =========================================================================
  226. IDX-Edit Version 1.00   (12/01/92)
  227.    Edit entries in a PCBoard 14.5(a) File Index.  To use type:
  228.  
  229.       IDX-EDIT [indexname[.IDX]  [/F]
  230.  
  231. Where indexname[.IDX] is the name of the index file to edit.
  232. (The .IDX file extension is optional.)
  233.  
  234. [/F] Tag first file also on duplicates
  235.  
  236. If not given, the file name will be prompted for.
  237.  
  238. This will be the most powerful Utility of the batch once it is finished.
  239.  
  240. Currently it allows for complete editing of the data in the index file.
  241. You can TAG files based on Duplicates in the index file, Files found in
  242. another index file, a FileMask, by Path Number, Path/FileMask in a text
  243. file, Path/File in a text report from IDX-DUPS or manually.
  244.  
  245. Tagging files by reading a file for Paths\FileNames, this will be either a
  246. straight file of filenames  (with/without paths) or a text file  generated
  247. by redirecting the output of IDX-DUPS to a file is possible.  The straight
  248. file format is 1 filespec per line.  This may include wildcards and paths.
  249. The paths must match the path  text in the IDX file exactly  or it will be
  250. skipped. An entry such as S:\001A\C*.* or Z*.* is considered legal.    The
  251. report format  skips all lines that do  not have a  colon in column 13 and
  252. the name at the start of the line does not match the current IDX file. The
  253. full name and path are checked and tagged if found.
  254.  
  255. The Tagged files may then be deleted, written to another index file or can
  256. be untagged manually or all at once.
  257.  
  258. Editing of Paths is also be possible to allow easy changing of drive letters,
  259. etc.   Paths will be able to be added or deleted in a future version and the
  260. path of any file will be able to be changed.
  261.  
  262. Other features will be available if I come up with any or requests are
  263. made, and I can work them in.
  264.  
  265. I also plan to add the ability to change the order of the files on duplicates.
  266. This will allow you to control which file PCBoard finds first (especially if
  267. you use IDX-MERG and combine several IDX files into one and want to place the
  268. more recent file first).
  269.  
  270. Currently only Displaying, Editing and Tagging are finished.
  271.  
  272. The program is pretty straight forward, so I will only mention some of the
  273. functions and keyboard commands available. From the Main Menu, either the
  274. Numeric key or Function key may be used to select a menu choice. Selections
  275. 4 & 5 will only function if there are files tagged. Selection 4 will prompt
  276. you for a file name and if the file exists, you will be prompted to confirm
  277. an overwrite. Selection 5 will prompt for confirmation of the deletion also.
  278.  
  279. When Displaying/Edit Filenames, The following functions are available:
  280.  
  281. Dn, Up       Move to Next/Prev FileName
  282. PgDn, PgUp   Move to Next/Prev Page
  283. Tab          Move to the Next Tagged Filename
  284. Shift-Tab    Move to the Prev Tagged Filename
  285. Alt-Key      Jump to first Filename starting with letter of Alt-Key pressed
  286.                (Alt-# jumps to Beginning,  Alt-= jumps to End)
  287. F2           Tag/UnTag current FileName (Cursor moves Down one line)
  288. F3           Jump to a Line (FileName) Number
  289. F5           Decrements Path Number
  290. F6           Increments Path Number
  291. F7           Flip All Tags
  292. F8           Clear All Tags
  293. F10          Special Tagging Menu
  294. Ctrl-D       Undo Edit of Current FileName (Restore Default Input)
  295. Ctrl-X       Clear Current FileName (Erase Field)
  296. Home, End    Go to Beginning/End of Field
  297. Left, Right  Move Cursor Left/Right
  298. Ctrl-Left,
  299.  Ctrl-Right  Move Cursor Left/Right one word
  300. Ins          Toggle Insert Mode (Starts in OFF on EACH new line)
  301. Del          Del Character at Cursor
  302. BS           Del Character Left of Cursor
  303. ESC          Exit (Current line edited will be aborted)
  304.  
  305. Once the Cursor has been moved to another line, the edited data has been
  306. written to the disk. MAKE BACKUPS of the files (although they are easily
  307. regenerated.)
  308.  
  309. When editing the actual Filename data,  keep in mind that PCBoard does a
  310. binary search on the file,  so if you change the name,  it may cause the
  311. search to fail. I recommend changing the last character to - or _ so the
  312. sorted order of the list is not affected.  If there are no duplicates of
  313. the file or you are changing the last filename of a duplicate,  use _ as
  314. the character.  If it is the first filename of a duplicate, use - as the
  315. character.  Changing the name shouldn't really be necessary now that you
  316. can delete a file from the index file by tagging it and using the delete
  317. function. A sort feature is planned for a future version to allow you to
  318. actually change a  name completely  (especially if you rename a  file on
  319. the hard disk itself and want to change the Index file instead of running
  320. MAKEIDX again.) Currently an external sort utility is provided (IDX-SORT)
  321. and if you change any filenames, I would recommend sorting the index just
  322. to be safe.
  323.  
  324. This has been a slow project as I have been writing them as I needed them
  325. and haven't spent much time on this one as my need for it has been low. If
  326. you have a need for it, let me know and I will spend more time on it.
  327. =========================================================================
  328. BBS CD-ROM Authors: Please feel free to include these Utilities with your
  329.    CD-ROM.   You may also include any  number of the files extracted from
  330.    the .ZIP file without my DOCS.  This will allow you to include an .IDX
  331.    file for your CD-ROM and include  IDX-DRIV.EXE  on the disk along with
  332.    a batch file (ROM.BAT for example) that allows the  User to change the
  333.    drive of the Index to fit their  needs without having to  regenerate a
  334.    new index file. An example of the batch file would be:
  335.  
  336.    IDX-DRIV YourFile %1 %2 /Q
  337.  
  338.    and the User would simply type ROM X to set the drive letter to X: after
  339.    copying the Index File and batch file to their hard drive.
  340. =========================================================================
  341. Note:  I haven't received much feedback on this project so I don't know if
  342. anyone is finding any use for the utilities or not.   If you are using the
  343. programs let me know and I will keep updating them and developing additonal
  344. programs.
  345. =========================================================================
  346.  
  347. CONTACTING THE AUTHOR
  348.  
  349. There are a number of ways to contact the author:
  350.  
  351.    1.  Call the support BBS, SHARP Technical Support Line BBS (404) 962-1788.
  352.  
  353.    2.  Fax: (404) 995-0613
  354.  
  355.    3.  Send net mail message through one of the mail networks addressed to
  356. 'Gary Meeker'. Available networks are P/Net, ProgNet, DevNet or SourceNet.
  357. I carry these Networks on my BBS so will see any mail in any conference. I
  358. also call SaltAir at least once a week so this is a perfect place to contact
  359. me also through the Utilities Conference.
  360.  
  361.    4.  Send letter through regular post to the following address:
  362.  
  363.          ATTN: Gary Meeker
  364.          SHARP Technical Support Line BBS
  365.          725-C Old Norcross Road
  366.          Lawrenceville, GA 30245
  367.  
  368. =========================================================================
  369. Source Code:
  370.  
  371. All programs are written in QuickBasic 4.5 and compiled using P.D.Q.
  372. from Crescent Software. This results in very small code. Also several
  373. routines from Crescent's QuickPack Professional Library and some of myown
  374. Library routines were used.
  375.  
  376. For those who would like source code, it can be obtained by sending $10
  377. to the address above, made payable to Gary Meeker. Specify 3.5" or 5.25" &
  378. DD or HD format disks. You will receive the QB4.5 source code and the
  379. assembly code and Library for myown routines. To compile the code you will
  380. need P.D.Q. & QuickPack Professional from Crescent Software or replace the
  381. Library calls by uncommenting the internal routines which accomplish the
  382. same functions but result in larger code. Compiling then can be done under
  383. QB4.5 just fine. (although the files will be 2 to 4 times as large.)
  384. =========================================================================
  385.